Server Watch Plugin SDK Date: 6 Feb 2004
Release: 1.0
Main Page | Class Hierarchy | Class List | File List | Class Members | File Members | Related Pages

ISWServerSettings.h

Go to the documentation of this file.
00001 /* 00002 ISWServerSettings.h 00003 Copyright (c) 2000-2004, Deep Fried Software. All rights reserved. 00004 */ 00005 00006 #if !defined(AFX_SWSETTINGGPLUGV1_0_0_H__FDF6EDA1_DE73_11D3_89EF_0040333C2E7E__INCLUDED_) 00007 #define AFX_SWSETTINGGPLUGV1_0_0_H__FDF6EDA1_DE73_11D3_89EF_0040333C2E7E__INCLUDED_ 00008 00009 #include "SWMacros.h" 00010 #include <string> 00011 00012 class SWHandle; 00013 00031 class ISWServerSettings 00032 { 00033 public: 00034 00147 virtual void BeginRead() = 0; 00148 00150 virtual void EndRead() = 0; 00151 00166 virtual void BeginWrite() = 0; 00167 00169 virtual void EndWrite() = 0; 00170 00182 virtual void Retain() = 0; 00183 00190 virtual void Release() = 0; 00192 00205 virtual bool ServerIsMonitoring() = 0; 00207 00218 virtual int GetPort() const = 0; 00219 00225 virtual std::wstring GetServerAddress() const = 0; 00226 00232 virtual std::wstring GetUserSetServerName() const = 0; 00233 00239 virtual std::wstring GetServerType() const = 0; 00240 00246 virtual SWHandle GetServerHandle() const = 0; 00247 00253 virtual SWHandle GetPluginHandle() const = 0; 00255 00268 virtual int GetTimeout() const = 0; 00270 00275 enum JOIN_PARAM_TYPE 00276 { 00277 ANY_TEXT, 00278 PASSWORD, 00279 00280 BOOLEAN 00281 00282 00283 00284 00285 }; 00286 00343 virtual SWRESULT CreateJoinParam( const int id, 00344 const std::wstring &name, 00345 const std::wstring &help, 00346 const bool required = false, 00347 JOIN_PARAM_TYPE type = ISWServerSettings::ANY_TEXT ) = 0; 00348 00372 virtual SWRESULT CreateJoinParam( const int id, 00373 const std::wstring &name, 00374 const std::wstring &help, 00375 const std::wstring &initialValue, 00376 const bool required = false, 00377 JOIN_PARAM_TYPE type = ISWServerSettings::ANY_TEXT ) = 0; 00378 00391 virtual SWRESULT GetJoinParamValue( const int id, std::wstring &value ) const = 0; 00392 00407 virtual SWRESULT SetJoinParamValue( const int id, const std::wstring &value ) = 0; 00408 00419 virtual SWRESULT GetJoinParamHelpText( const int id, std::wstring &help ) const = 0; 00420 00431 virtual SWRESULT SetJoinParamHelpText( const int id, const std::wstring &help ) = 0; 00432 00441 virtual std::wstring GetJoinApp() const = 0; 00442 00452 virtual SWRESULT SetJoinApp( const std::wstring &theApp ) = 0; 00453 00462 virtual std::wstring GetJoinParamsFreeForm() const = 0; 00463 00475 virtual SWRESULT SetJoinParamsFreeForm( const std::wstring &theManualParams ) = 0; 00477 }; 00478 00479 #endif // !defined(AFX_SWSETTINGGPLUGV1_0_0_H__FDF6EDA1_DE73_11D3_89EF_0040333C2E7E__INCLUDED_)


Copyright (c) 2003-2004, Deep Fried Software. All rights reserved.